Skip to content

Follow-up: Complete Configurable Versioning (from PR #33)#38

Merged
PaulWinterstein merged 13 commits into
mainfrom
35-follow-up-complete-configurable-versioning-from-pr-33
May 29, 2025
Merged

Follow-up: Complete Configurable Versioning (from PR #33)#38
PaulWinterstein merged 13 commits into
mainfrom
35-follow-up-complete-configurable-versioning-from-pr-33

Conversation

@PaulWinterstein

@PaulWinterstein PaulWinterstein commented May 27, 2025

Copy link
Copy Markdown
Collaborator

This PR completes the follow-up tasks from Issue #35, building on the foundation established in PR #33.

Version Compatibility Checks

Two mechanisms were introduced to validate compatibility between the connected VideoIPath server and the local model configuration:

  • Basic Check (always enabled): Compares the connected VideoIPath server version with the configured version. If a mismatch occurs and the server version is found among the available versions or a fallback version can be determined, a message is logged with instructions on how to set this version.

  • Advanced Check (optional, enabled by default): Compares the driver schema model — focusing on custom settings — against the reference schema retrieved from the server. This check is enabled by default but can be disabled via the VIPAT_ADVANCED_DRIVER_SCHEMA_CHECK environment variable or a function parameter in VideoIPathApp. It highlights differences such as removed drivers, newly added ones, or changes to custom settings.

Additional Improvements

  • Documentation Updates
    • Removed the Driver Compatibility Guide and replaced it with the Driver Versioning Guide, which explains how to configure the VideoIPath version for the local model.
    • Updated the project's README and Getting Started Guide (01_Setup_and_connect_to_Server) to reflect these new features.
  • Refactored Version Scripts and Utils
    • Moved the scripts folder and introduced dynamic method loading to prevent import errors.
    • Introduced constants SELECTED_SCHEMA_VERSION and AVAILABLE_SCHEMA_VERSIONS in generated drivers.py for easy access to the currently configured model version and available versions during development and runtime.
    • Added scripts to display the currently configured model version (get-videoipath-version) and list all available model versions (list-videoipath-versions).
  • Driver Schema Updates
    • Added driver schema for version 2023.4.37.
    • Bumped the default VideoIPath server version to 2024.4.12 (LTS). Regenerated drivers.py and updated the documentation accordingly.

@PaulWinterstein PaulWinterstein linked an issue May 27, 2025 that may be closed by this pull request
3 tasks
…ate paths to avoid generic naming and potential import conflicts, write poetry.lock

@JonasScholl JonasScholl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very cool, LGTM 👍

@PaulWinterstein PaulWinterstein marked this pull request as ready for review May 29, 2025 13:43
@PaulWinterstein PaulWinterstein merged commit 3d36026 into main May 29, 2025
7 checks passed
@PaulWinterstein PaulWinterstein deleted the 35-follow-up-complete-configurable-versioning-from-pr-33 branch May 29, 2025 13:51
@PaulWinterstein PaulWinterstein self-assigned this May 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Follow-up: Complete Configurable Versioning (from PR #33)

2 participants